<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="metastore_v1.html">Dataproc Metastore API</a> . <a href="metastore_v1.projects.html">projects</a> . <a href="metastore_v1.projects.locations.html">locations</a> . <a href="metastore_v1.projects.locations.services.html">services</a> . <a href="metastore_v1.projects.locations.services.metadataImports.html">metadataImports</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, metadataImportId=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new MetadataImport in a given project and location.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single import.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists imports in a service.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a single import. Only the description field of MetadataImport is supported to be updated.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, metadataImportId=None, requestId=None, x__xgafv=None)</code>
  <pre>Creates a new MetadataImport in a given project and location.

Args:
  parent: string, Required. The relative resource name of the service in which to create a metastore import, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # A metastore resource that imports metadata.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the metadata import was started.
  &quot;databaseDump&quot;: { # A specification of the location of and metadata about a database dump from a relational database management system. # Immutable. A database dump from a pre-existing metastore&#x27;s database.
    &quot;databaseType&quot;: &quot;A String&quot;, # The type of the database.
    &quot;gcsUri&quot;: &quot;A String&quot;, # Optional. A Cloud Storage object or folder URI that specifies the source from which to import metadata. It must begin with gs://.
    &quot;sourceDatabase&quot;: &quot;A String&quot;, # Optional. The name of the source database.
    &quot;type&quot;: &quot;A String&quot;, # Optional. The type of the database dump. If unspecified, defaults to MYSQL.
  },
  &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the metadata import.
  &quot;endTime&quot;: &quot;A String&quot;, # Output only. The time when the metadata import finished.
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. The relative resource name of the metadata import, of the form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}.
  &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the metadata import.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the metadata import was last updated.
}

  metadataImportId: string, Required. The ID of the metadata import, which is used as the final component of the metadata import&#x27;s name.This value must be between 1 and 64 characters long, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.
  requestId: string, Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
  &quot;error&quot;: { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets details of a single import.

Args:
  name: string, Required. The relative resource name of the metadata import to retrieve, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{import_id}. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A metastore resource that imports metadata.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the metadata import was started.
  &quot;databaseDump&quot;: { # A specification of the location of and metadata about a database dump from a relational database management system. # Immutable. A database dump from a pre-existing metastore&#x27;s database.
    &quot;databaseType&quot;: &quot;A String&quot;, # The type of the database.
    &quot;gcsUri&quot;: &quot;A String&quot;, # Optional. A Cloud Storage object or folder URI that specifies the source from which to import metadata. It must begin with gs://.
    &quot;sourceDatabase&quot;: &quot;A String&quot;, # Optional. The name of the source database.
    &quot;type&quot;: &quot;A String&quot;, # Optional. The type of the database dump. If unspecified, defaults to MYSQL.
  },
  &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the metadata import.
  &quot;endTime&quot;: &quot;A String&quot;, # Output only. The time when the metadata import finished.
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. The relative resource name of the metadata import, of the form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}.
  &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the metadata import.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the metadata import was last updated.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists imports in a service.

Args:
  parent: string, Required. The relative resource name of the service whose metadata imports to list, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports. (required)
  filter: string, Optional. The filter to apply to list results.
  orderBy: string, Optional. Specify the ordering of results as described in Sorting Order (https://cloud.google.com/apis/design/design_patterns#sorting_order). If not specified, the results will be sorted in the default order.
  pageSize: integer, Optional. The maximum number of imports to return. The response may contain less than the maximum number. If unspecified, no more than 500 imports are returned. The maximum value is 1000; values above 1000 are changed to 1000.
  pageToken: string, Optional. A page token, received from a previous DataprocMetastore.ListServices call. Provide this token to retrieve the subsequent page.To retrieve the first page, supply an empty page token.When paginating, other parameters provided to DataprocMetastore.ListServices must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for DataprocMetastore.ListMetadataImports.
  &quot;metadataImports&quot;: [ # The imports in the specified service.
    { # A metastore resource that imports metadata.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the metadata import was started.
      &quot;databaseDump&quot;: { # A specification of the location of and metadata about a database dump from a relational database management system. # Immutable. A database dump from a pre-existing metastore&#x27;s database.
        &quot;databaseType&quot;: &quot;A String&quot;, # The type of the database.
        &quot;gcsUri&quot;: &quot;A String&quot;, # Optional. A Cloud Storage object or folder URI that specifies the source from which to import metadata. It must begin with gs://.
        &quot;sourceDatabase&quot;: &quot;A String&quot;, # Optional. The name of the source database.
        &quot;type&quot;: &quot;A String&quot;, # Optional. The type of the database dump. If unspecified, defaults to MYSQL.
      },
      &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the metadata import.
      &quot;endTime&quot;: &quot;A String&quot;, # Output only. The time when the metadata import finished.
      &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. The relative resource name of the metadata import, of the form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}.
      &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the metadata import.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the metadata import was last updated.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
  &quot;unreachable&quot;: [ # Locations that could not be reached.
    &quot;A String&quot;,
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates a single import. Only the description field of MetadataImport is supported to be updated.

Args:
  name: string, Immutable. Identifier. The relative resource name of the metadata import, of the form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}. (required)
  body: object, The request body.
    The object takes the form of:

{ # A metastore resource that imports metadata.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the metadata import was started.
  &quot;databaseDump&quot;: { # A specification of the location of and metadata about a database dump from a relational database management system. # Immutable. A database dump from a pre-existing metastore&#x27;s database.
    &quot;databaseType&quot;: &quot;A String&quot;, # The type of the database.
    &quot;gcsUri&quot;: &quot;A String&quot;, # Optional. A Cloud Storage object or folder URI that specifies the source from which to import metadata. It must begin with gs://.
    &quot;sourceDatabase&quot;: &quot;A String&quot;, # Optional. The name of the source database.
    &quot;type&quot;: &quot;A String&quot;, # Optional. The type of the database dump. If unspecified, defaults to MYSQL.
  },
  &quot;description&quot;: &quot;A String&quot;, # Optional. The description of the metadata import.
  &quot;endTime&quot;: &quot;A String&quot;, # Output only. The time when the metadata import finished.
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. The relative resource name of the metadata import, of the form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}.
  &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the metadata import.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the metadata import was last updated.
}

  requestId: string, Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
  updateMask: string, Required. A field mask used to specify the fields to be overwritten in the metadata import resource by the update. Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
  &quot;error&quot;: { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

</body></html>